FlowDocument Properties
An object defining properties for the FlowDocument class.
Key
A unique identifier for the workflow step.
Type: string
WorkflowCodeInstance
The workflow code instance associated with the flow object.
Type: IWorkflowCode
CachedDMObjects
The cached document management objects related to the flow object.
Type: IRuntimeDMObjects
FormCaption
Specifies the caption of the form associated with the document.
Type: string
ViewId
Identifies the ID of the view associated with the document.
Type: string
DocumentId
Represents the unique identifier for the document.
Type: long
FormName
Represents the name of the form associated with the document.
Type: string
ProcessName
Represents the name of the process associated with the document.
Type: string
IsChanged
Indicates whether the document properties have been modified.
Type: bool
TypeCode
The type code associated with the flow object.
Type: WorkflowItemTypeCode
Accepted Values:
Name Value FlowComment -1 FlowStart 10 FlowEnd 11 FlowPosition 15 FlowAssign 21 FlowCompare 22 FlowOr 24 FlowAnd 25 FlowMail 26 FlowProfession 27 FlowDepartment 28 Variable 30 FlowScript 31 FlowNode 33 FlowGroup 37 FlowTimer 39 FlowTimerStarter 40 FlowTimerStopper 41 FlowApprovalCancellar 42 Pauser 44 SubFlowCall 51 SubFlowBegin 52 SubFlowEnd 53 FlowPushNotification 54 FlowDocument 56 FlowCreateDocument 57 FlowDocumentSynchronizer 58 FlowStarterPosition 59 FlowDocumentState 63 FlowUniqueIdCreator 65 FlowSetDocumentId 66 FlowDeleteDocument 67 FlowPDFExport 68 FlowXMLExport 69 FlowMailSender 75 FlowParallel 79 FlowContinue 80 FlowTrigger 81 FlowActionCreator 82 FlowDigitallySigning 83 FlowGptPrompt 84
Type
Specifies the type of document to be created.
Type: CreateDocumentType
Accepted Values:
Name Value None 0 CreateForm 1 AddExisting 2
Name
Name for the workflow step.
Type: string
ViewName
Defines the name of the view linked to the document.
Type: string
ExistingDocumentPath
Specifies the path to an existing document.
Type: string
Parameters
Represents a dictionary of parameters associated with the document.
Type: Dictionary<string, object>
PanelSize
Represents the size of the panel associated with the document.
Type: PanelSize
Accepted Values:
Name Value None 0 Small 1 Medium 2 Large 3
FileId
Specifies the file ID linked to the document.
Type: string
DeploymentUrl
Specifies the deployment URL for the document.
Type: string
FormInstance
The FormInstance class manages a form instance, providing properties and methods for handling form settings, secrets, user events, deployment URL configurations, and controls. It integrates encryption and decryption for secure management of SecretKey and other sensitive data.
Type: [FormInstance](../../../../Service API/Models/FormInstance/FormInstance.md)
BuildManagerSettings
Represents the build manager settings for the workflow.
Type: Settings
Caption
The caption dictionary representing localized captions for the flow object.
Type: Dictionary<string, string>
ProcessId
Defines the process ID associated with the document.
Type: string
Controls
The Controls class represents a collection of form controls within a client form, providing access through an indexer.
Type: [Controls](../../../../Service API/Models/Controls/Controls.md)
FormId
Identifies the form ID related to the document.
Type: string